/*
 * Copyright (C) 2010 Fores Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.fores.midori.core.util;

import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.OutputStream;
import java.io.Serializable;

import jp.fores.midori.core.io.CustomClassLoaderObjectInputStream;
import jp.fores.midori.core.io.SizeCountOutputStream;


/**
 * Commons Lang のSerializationUtilsクラスを改良して、メソッドを追加したり、独自のクラスローダーも扱えるようにしたクラス。<br>
 * また、JDK本体以外のクラスに依存しないようにしています。<br>
 * <br>
 * 独自のクラスローダーを使いたい場合は、publicフィールド <code>{@link #classLoader}</code>の値として設定して下さい。<br>
 * (このクラスの全てのメソッドはスレッドセーフです。)<br>
 */
public class MidoriSerializationUtils {
	//==========================================================
	//フィールド

	/**
	 * クラスローダー
	 */
	public static ClassLoader classLoader = null;


	//==========================================================
	//メソッド

	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//コンストラクタ

	/**
	 * コンストラクタです。<br>
	 * (クラスメソッドのみのユーティリティークラスなので、privateにしてインスタンスを作成できないようにしています。)<br>
	 */
	private MidoriSerializationUtils() {
		//基底クラスのコンストラクタの呼び出し
		super();
	}


	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//クラスメソッド

	/**
	 * オブジェクトのシリアライズ・デシリアライズの仕組みを利用して、ディープコピーを作成します。<br>
	 * 入れ子になっているオブジェクトも全て <code>{@link Serializable}</code>である必要があるので、注意して下さい。<br>
	 *
	 * @param <T> オブジェクトの型
	 * @param obj クローンを作成するオブジェクト
	 * @return クローン
	 * @throws IOException 入出力エラーが発生した場合
	 * @throws ClassNotFoundException クラスが見つからなかった場合
	 */
	public static <T extends Serializable> T clone(T obj) throws IOException,
			ClassNotFoundException {
		//引数のオブジェクトをシリアライズして、すぐにデシリアライズすることによりクローンを作成して返す
		return (T) deserialize(serialize(obj));
	}

	/**
	 * オブジェクトをシリアライズして、結果を出力ストリームに書きこみます。<br>
	 * 出力ストリームは処理終了後にこのメソッドの内部で閉じるので、注意して下さい。<br>
	 *
	 * @param obj シリアライズするオブジェクト
	 * @param outputStream 出力ストリーム
	 * @throws IOException 入出力エラーが発生した場合
	 */
	public static void serialize(Serializable obj, OutputStream outputStream)
			throws IOException {
		//引数の出力ストリームがBufferedOutputStreamでない場合
		if (!(outputStream instanceof BufferedOutputStream)) {
			//一応バッファリングしておく
			outputStream = new BufferedOutputStream(outputStream);
		}

		//入力ストリームをObjectOutputStreamでラッピングする
		ObjectOutputStream oos = new ObjectOutputStream(outputStream);

		try {
			//引数のオブジェクトをObjectOutputStreamに書き込む
			oos.writeObject(obj);
		}
		//終了処理
		finally {
			try {
				//ObjectOutputStreamを閉じる
				oos.close();
			}
			//ObjectOutputStreamを閉じるのに失敗した場合
			catch (IOException ex) {
				//どうしようもないので、何もしない
			}
		}
	}

	/**
	 * オブジェクトをシリアライズして、結果をバイト配列として取得します。<br>
	 *
	 * @param obj シリアライズするオブジェクト
	 * @return シリアライズした結果のバイト配列
	 * @throws IOException 入出力エラーが発生した場合
	 */
	public static byte[] serialize(Serializable obj) throws IOException {
		//引数のバイト配列をByteArrayOutputStreamでラッピングする
		ByteArrayOutputStream baos = new ByteArrayOutputStream();

		//実際に処理を行うメソッドを呼び出す
		serialize(obj, baos);

		//結果をバイト配列として取得する
		return baos.toByteArray();
	}

	/**
	 * オブジェクトをシリアライズした場合に出力されるサイズを計算します。<br>
	 *
	 * @param obj シリアライズするオブジェクト
	 * @return オブジェクトをシリアライズした場合に出力されるサイズ
	 * @throws IOException 入出力エラーが発生した場合
	 */
	public static long countSerializeSize(Serializable obj) throws IOException {
		//サイズ計算用の出力ストリームのインスタンスを計算
		SizeCountOutputStream os = new SizeCountOutputStream();

		//引数のオブジェクトをシリアライズする
		serialize(obj, os);

		//サイズ計算用の出力ストリームから、結果のサイズを取得して返す
		return os.getSize();
	}

	/**
	 * 入力ストリームから読み込んだ内容をデシリアライズします。<br>
	 * 入力ストリームは処理終了後にこのメソッドの内部で閉じるので、注意して下さい。<br>
	 *
	 * @param inputStream 入力ストリーム
	 * @return デシリアライズしたオブジェクト
	 * @throws IOException 入出力エラーが発生した場合
	 * @throws ClassNotFoundException クラスが見つからなかった場合
	 */
	public static Object deserialize(InputStream inputStream)
			throws IOException, ClassNotFoundException {
		//引数の入力ストリームがBufferedOutputStreamでない場合
		if (!(inputStream instanceof BufferedInputStream)) {
			//一応バッファリングしておく
			inputStream = new BufferedInputStream(inputStream);
		}

		//入力ストリームをObjectInputStreamでラッピングする
		//(普通のObjectInputStreamを使うのではなく、指定されたクラスローダーを使用するCustomClassLoaderObjectInputStreamを使用する)
		ObjectInputStream ois = new CustomClassLoaderObjectInputStream(inputStream, classLoader);

		try {
			//ObjectInputStreamから読み込んだオブジェクトをそのまま返す
			return ois.readObject();
		}
		//終了処理
		finally {
			try {
				//ObjectInputStreamムを閉じる
				ois.close();
			}
			//ObjectInputStreamを閉じるのに失敗した場合
			catch (IOException ex) {
				//どうしようもないので、何もしない
			}
		}
	}

	/**
	 * バイト配列の内容をデシリアライズします。<br>
	 *
	 * @param byteArray バイト配列
	 * @return デシリアライズしたオブジェクト
	 * @throws IOException 入出力エラーが発生した場合
	 * @throws ClassNotFoundException クラスが見つからなかった場合
	 */
	public static Object deserialize(byte[] byteArray) throws IOException,
			ClassNotFoundException {
		//引数のバイト配列をByteArrayInputStreamでラッピングして、実際に処理を行うメソッドを呼び出す
		return deserialize(new ByteArrayInputStream(byteArray));
	}

}
